home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 5 / Apprentice-Release5.iso / Utilities / Installers / QuickInstaller 1.0.0 / User's Manual < prev   
Text File  |  1996-06-02  |  14KB  |  193 lines

  1. QuickInstaller User's Manual
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Contents:
  8. ..........................About QuickInstaller.
  9. ..........................Quick Start.
  10. ..........................Installer Document.
  11. ..........................The document window.
  12. ..........................File Management.
  13. ..........................Make the Installer.
  14. ..........................The Built Installer.
  15. ..........................Compression.
  16. ..........................Memory.
  17. ..........................Some little suggestion.
  18.  
  19. About QuickInstaller
  20. QuickInstaller allows you to create straightforward an installer for distributing any kind of file. You can build your own installer application, with any feature you want, in a very simple way. QuickInstaller has Balloon Help™ available.
  21. QuickInstaller is shareware, it costs less than a small utility and anyone should afford it.
  22. The QuickInstaller Maker (QIM) unregistered version is fully working,  but shows always its about box, at startup.
  23. When you register QIM the "irritating" about box don't more appears and any "unregistered" notice will be replaced by the registration infos, on The Built Installer (TBI) as well.
  24. QIM requires at least System 7 and a 68030 processor to run. TBI requires at least System 7 but runs on any processor type.
  25.  
  26. Quick Start
  27. Want you to create an Installer in few seconds? Try this:
  28. 1) Launch QIM. 
  29. 2) Select "New Installer Document..." from "File" menu, press "Save" in the "Put File" dialog and press "OK" in the "Document Setup" dialog. 
  30. 3) Press the "Add" button in the Main window, select a file to install from "Get File" dialog and press "OK"  in the "File Setup" dialog. 
  31. 4) Select "Make Installer…" from "File" menu, check the "Single Installer" checkbox in the "Installer Setup" dialog and press "OK", then press "Make" in the following dialog. 
  32. 5) From "Get File…" dialog select the Installer Document you've created at the point 2 and...your first Installer is ready!
  33. QuickInstaller is a very fast Installer builder, if you want to know more about it, read the following chapters.
  34.  
  35. Installer Document
  36. The QIM's heart is the Installer Document (ID).
  37. Any ID is a common destination for the files contained in the ID. This means that you should create a different ID for any different destination you want to install your files to.
  38.     •Example: if you want to install some files into the Extensions Folder and some files into the Apple Menu Folder, you should create two ID, one containing the files for the Extensions Folder and one containing the files for the Apple Menu Folder, then include both IDs to the same installer.•
  39. You may create a new ID through the "File" menu,  by selecting the item "New Installer Document".
  40.     •Important: make sure you insert a more or less "final" name for the ID in the "Save File Dialog", since QIM then makes this name unchangeable.•
  41.  
  42. The default name shown by QIM in the "Save File Dialog"  is "New Document.nst".  You may change it, obviously. The suffix ".nst" isn't relevant: you can remove it, if you like.
  43. When you press the "Save" button in the "Save File Dialog"  the "Document Setup" window appears.
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59. From this window you may select the ID's common destination. The available destinations are:
  60.             "HD (root level)", this option installs the files contained in the current ID at the root level of the HD selected by your final user.  The following options, instead, always install the files contained in the current ID on the startup disk:
  61.             "System Folder",    "Desktop Folder", "Startup Folder", "Shutdown Folder", "Apple Menu Folder", "Control Panel Folder", "Extensions Folder",    "Font Folder", "Preferences Folder".
  62. The "Document Setup" window contains another option:
  63. by checking the checkbox "Group all files into the same folder", all the current ID's files will be grouped in a new folder into the common destination folder (you must type the new folder's name).
  64.  
  65.  
  66.  
  67.  
  68.  
  69.     •Example: if you  select the "Extensions Folder" as a common destination and then check the checkbox "Group all files into the same folder" (naming the new folder "My Folder") the installer will place the files contained in that ID into a folder named "My Folder" placed in the Extensions Folder•
  70.     •Important: you can't create more than one folder in the same ID.  But, since it's possible to include many IDs with the same common destination in the same installer, if you want to create more than one folder in the same destination folder, you must create several IDs, then include these IDs in the same installer.  •Example: you want to include, in the preferences folder, a new folder called "My Folder" and another new folder called "Your Folder", you must create an ID containing the files for "My Folder" (remembering to set correctly the related "Document Setup" window) and an ID containing the files for "Your Folder" (remembering again to set correctly the related "Document Setup" window). When you'll build the installer simply add both IDs to that installer.••
  71.  
  72. The document window
  73. The "document window" appears when you open an existing ID through the "File" menu  by selecting the item "Open Installer Document" or when you double-click on an ID icon or after you've created a new ID through "File" menu  by selecting the menu item "New Installer Document".
  74. This is the "working" window.  A "document window" is always associated to an ID. 
  75.  
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94. When the "document window" is open you may:
  95. 1) View the files contained into the associated ID. For each file you may view name, target Macintosh (see the section "File Management"), type, size, compression state (see section "Compression"). 
  96. 2) View the ID flags* (general destination, new folder name, size).
  97. 3) Change the ID flags, by pressing the "Change Document flags" button or by selecting the "Change Document flags" menu item in the "File" menu, or by the shortcut cmd-C. When you want to change the document flag, the "Document Setup" window appears. 
  98. 4) Change the flags of the files you want by pressing the "Change  File flags" button or by selecting the "Change File flags" menu item in the "Document" menu, or by the shortcut cmd-H.  When you want to change the file flag, the "File Setup" window appears (see section "File Management"). You can't change the compression state. 
  99. 5) Remove a file by pressing the "Remove" button or by selecting the "Remove" menuitem, in the "Document" menu, or with the shortcut cmd-R. 
  100. 6) Extract a file by pressing the "Extract" button or by selecting the "Extract" menui tem, in the "Document" menu, or by the shortcut cmd-E. 
  101. 7) Add a file by pressing the "Add" button or by selecting the "Add File to Document…" menu item, in the "Document" menu, or by the shortcut cmd-A.
  102.     •Important: the buttons and the menu items "Change File flags", "Remove", "Extract" are enabled only if a file is selected in the "document window". The menu item "Change Document flags" is enabled only if a "document window" is open.•
  103.     •Note: you can't find, in QIM, a "Save" menu item because it saves any change by itself. •
  104.  
  105. * For those who aren't too much used to programming terms… a "FLAG" is generally an information that defines a property (and not the contents) of a file or group of files.  In our case, the "FLAG"  of an ID contains the destination of the ID's files. There is actually a parallelism between the actual meaning of FLAG (those which move with the wind) and the 'software' meaning: when a program (such as QIM, or the Finder for example) looks for a set of files with the same property, it will be much easier to find them if the property is written in a separate, universal (common-for-all) part of the file.  ;-)
  106.  
  107. File Management
  108. When a "document window" is open you may, finally, add files to the related ID.
  109. To add a file, as already illustrated in the earlier sections, you may press the "Add" button or select the "Add File to Document…" menu item, in the "Document" menu, or use the shortcut cmd-A.
  110. After you've selected a file in the "Get File" dialog, the "File Setup" dialog appears. 
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127. From the "File Setup" dialog you may choose the target Macintosh, i.e. the computer type on wich your file will be installed.  Targets are: 68K Macs, PowerMacs, all Macs. From the "File Setup" dialog you can also change the file name and decide whether to compress the file (see section "Compression") or not.
  128. When a file is selected in the "document window" you may remove it  from the related ID, extract it or change its flags (see previous section).
  129.     •Important: make sure to use unique file names in the same ID: when QIM manages a file, it looks for it by name in the ID. •
  130.  
  131. Make the Installer
  132. To build an installer you should choose the menu item  "Make Installer…", from the "File" menu (shortcut cmd-M). 
  133. The "Installer Setup" dialog appears.
  134.  
  135.  
  136.  
  137.  
  138.  
  139.  
  140.  
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  In this window you must insert the name of TBI . The "Installer Setup" dialog allows you also to decide whether TBI should quit any running process when launched and restart the Mac when done, or not.  You may choose a text file that TBI will show in its spalsh screen (if the file is a SimpleText styled text the splash screen will even show the styles). 
  152. You may also choose a pict file that TBI will show in the main window (the size of pict must be 150x150 pts maximum).
  153. The last "Installer Setup" option allows you to decide whether TBI should be single or multiple.
  154. When you press "OK", in the "Installer Setup" dialog, QIM will build the installer.
  155.  
  156.   √ MULTIPLE INSTALLER
  157. QIM shows you a "Get File Dialog"; from this dialog you select the first ID you want to include in TBI. If you select an ID and then press "Open",  QIM shows another "Get File Dialog" from which you can select the second ID, and so on, until you press "Cancel".
  158.     •Important: if you press "Cancel" in the first "Get File Dialog" the entire operation is cancelled.•
  159.  
  160. At the end of this procedure you will find, on your HD, TBI and a folder named "Installer Files" containing the copies of the ID you've selected, in a format that TBI can recognize. You may now distribute your installer. 
  161.  
  162.     •Important: QIM creates TBI at its same level, in other words inside its folder. If an old TBI with the same name of the new already exists, QIM deletes it automatically. The same for the "Installer Files" . •Important: the "Installer Files" isn't very important as such. Only it's contents is important.  You may distribute your installer the way you want: without this folder or even with the installer files on a different media (see section "The Built Installer"). Just be sure to make the IDs available on some media carried with TBI.••
  163.  
  164.   √ SINGLE INSTALLER
  165. The option "Single Installer" allows you to create an installer without installer document: the installer contains the files to install inside itself. Limitation: only one destination is allowed. In fact when you press "Open" in the "Installer Setup" window only one "Get File Dialog" appears: when you select an Installer document the files the document contains are copied into TBI.
  166.  
  167. The Built Installer
  168.  
  169.  
  170.  
  171.  
  172. Some words about TBI: it allows to select the destination volume, but installs all system items into the current System folder. This means that the choosed volume is only for documents with "HD" destination. Make sure to inform your user, if needed, in the splash screen text. If, during installation, TBI finds a name collision, it moves the old files in the trash, if a file with the same name already exists in the trash, then TBI deletes the old file. Again, make sure to inform your user, if needful, in the splash screen text. 
  173. When TBI installs files with "HD" destination put the files at the root level of the HD inside a new folder with the same name of TBI, but with the suffix "ƒ".
  174.     •Important: TBI (multiple installer version) searches for an ID in the "Installer Files" first (at the same location of TBI); 
  175.  
  176.  
  177.  
  178.  
  179.  
  180. If the "Installer Files" doesn't exist or doesn't contain the target ID, then TBI searches outside the "Installer Files". If TBI doesn't find the target ID, then ejects all insterted floppies and asks for the ID, through a "Get File Dialog". If the user presses "Cancel", the installation is aborted.•
  181.     •Important: the size needed, shown in TBI's main window, is the size of data contained. Since its independent documents based structure TBI cant't know the final size of compressed data.•
  182.  
  183. Compression
  184. Decompressing any single compressed file both QIM and TBI create a temporary document with the same size of the compressed file. Compressing any single file both QIM and TBI create a temporary document with the same size of the original file. This means that you must have some extra disk space compressing or decompressing files, remember it and inform your final users, if needful.
  185.   •Note: on decompression the temporary document is automatically deleted after few seconds, on compression it's deleted when the file is entirely compressed.•
  186.  
  187. Memory
  188. Both QIM and TBI use temporary memory,  so they can manage very large files with a small memory partition size. But the world is relative so, if QIM has some trouble to work with large files, try to quit the other running applications or try to increase its memory partition size. Remember to test TBI before to distribute it, and increase its memory partition size, if deeded. I've tested both QIM and TBI with single files large more than 6MB without problems, using the standard memory partition size.
  189.  
  190. Some little suggestion
  191. Compression slackens the jobs, since TBI must use the disk, so if your goal is the speed, don't compress the files: TBI will use the RAM speeding up the works. Vice versa, if the speed isn't very important for you, use the compression, the files size will be reduced about by 45/50%!
  192.  
  193. Enjoy, and remember to register the shareware.